Management API

Base Resource URL:

     https://portal-sandbox.seapay.com.sa/api/v01/customers/[customer-id]/transactions

Description:

Provides access to the transactions associated with the specified customer.

Available sub-resources:

Resource URL Description
https://portal-sandbox.seapay.com.sa/api/v01/customers/[customer-id]/transactions/[transaction-id]    Provides access to management of the specified transaction.

Supported Actions:

create  
Method:  PUT       Implicit:  Yes       Returns:  Transaction *      
Consumes:  json, xml  Produces:  json, xml 
 
Create transaction to generate invoice records linked to customers and track payment activities.
- Transactions are linked to the merchant account that processes them.
- Include payment method, amount, and status details.
- For one-time or on-demand payments, use Transaction API instead of Billing API.
- For Direct Debit (ACH), subscribe to NOC and return webhooks for real-time updates on account changes and status.

Parameters:
# Name Type Required Default Description
01 object Transaction * Yes Represents a transaction associated with a particular merchant.

find  
Method:  GET       Implicit:  Yes       Returns:  Transaction[] *      
Consumes:  xurl  Produces:  json, xml 
 
Returns a list of the transactions associated with the specified customer.

Parameters:
# Name Type Required Default Description
01 offset Integer No 0 Index of the first record returned from the search result.\n\r\n> **Note:** Used with limit parameter for pagination. Use this field for implementing paginated results.
02 limit Integer No 100 Maximum number of records to load per search call.\n\r\n> **Note:** Adjust based on performance requirements. Use this field to balance response size and performance.
03 createDateFrom Date No The starting date for filtering transaction records; only records dated from this specific day onwards are included.
04 createDateTo Date No The concluding date for filtering transaction records; only records up to and through this specified date are included.

process  
Method:  POST       Implicit:  No       Returns:  Transaction *      
Consumes:  json, xml  Produces:  json, xml 
 
Creates and processes a transaction associated with the specified customer.

Parameters:
# Name Type Required Default Description
01 object ProcessingRequest * Yes Represents information included in processing request sent to a processor.

Copyright © SeaPay. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.